refactor(api): use Sequence for read-only collection parameters#139
Merged
refactor(api): use Sequence for read-only collection parameters#139
Conversation
Replace concrete `list[...] | tuple[...]` unions with `collections.abc.Sequence` in the public API signatures for `run_many`, `create_cache`, `normalize_request`, and `create_cache_impl`. These functions only iterate over their inputs (never mutate), so `Sequence` accurately reflects the contract. Because `Sequence` is covariant, this eliminates mypy invariance errors when callers pass a `list[str]` where `list[str | None]` was expected — a paper cut that previously required callers to use tuples or widen their annotations. All imports are typing-only (behind `TYPE_CHECKING`). No runtime behavior change.
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Replace concrete
list[...] | tuple[...]unions withcollections.abc.Sequencein public API signatures (run_many,create_cache,normalize_request,create_cache_impl). These functions only iterate -Sequenceaccurately reflects the contract and eliminates mypy invariance errors for callers passinglist[str]wherelist[str | None]was expected.Related issue
None
Test plan
No new tests - non-behavioral change. Type annotations only; no runtime code altered.
just checkpasses (lint + mypy strict + 176 tests)list[str]→list[str | None]but acceptslist[str]→Sequence[str | None]